Skip to content

Add Appwrite React library docs and launch post#3022

Open
atharvadeosthale wants to merge 9 commits into
mainfrom
react-library
Open

Add Appwrite React library docs and launch post#3022
atharvadeosthale wants to merge 9 commits into
mainfrom
react-library

Conversation

@atharvadeosthale

Copy link
Copy Markdown
Member

Adds the /docs/products/auth/react hub, rewrites the React, Next.js, and TanStack Start quickstarts to use @appwrite.io/react, and ships an announcement post under blog/post/announcing-appwrite-react-library.
Also updates /docs/sdks and adds a "React library" entry to the Auth sidebar.

Adds /docs/products/auth/react hub covering the provider, hooks, server helpers, handler routes, and OAuth flow. Rewrites the React, Next.js, and TanStack Start quickstarts to use @appwrite.io/react. Adds a launch blog post under blog/post/announcing-appwrite-react-library and a new "React library" entry in the Auth sidebar. Updates /docs/sdks to list the package.
@appwrite

appwrite Bot commented May 25, 2026

Copy link
Copy Markdown

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Building Building View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Queued Queued View Logs Preview URL QR Code


Tip

Our Discord community has grown to 24K developers, and counting

@greptile-apps

greptile-apps Bot commented May 25, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR introduces the @appwrite.io/react library docs: a new /docs/products/auth/react reference page, rewritten React, Next.js, and TanStack Start quickstarts, a blog announcement post with cover image, a changelog entry, and an entry on the SDKs page.

  • The core documentation (hook tables, server helper examples, handler route snippets) is consistent and accurate across all three framework quickstarts and the reference page.
  • One issue: the .optimize-cache.json entry records the blog cover as cover.png while the committed file is cover.avif, causing a filename mismatch in the optimization cache.

Confidence Score: 4/5

Safe to merge after fixing the optimize-cache.json filename mismatch; all documentation content is accurate.

The only active defect is in .optimize-cache.json, where the newly added cover image is registered under the wrong extension (cover.png vs the actual cover.avif). If the image optimization pipeline relies on this cache to locate or skip files, it will fail to process the real image correctly. Everything else — hook docs, server helper examples, quickstart code snippets, sidebar wiring — is consistent and correct.

.optimize-cache.json has the wrong file extension for the cover image key.

Important Files Changed

Filename Overview
.optimize-cache.json Cache entry added for cover.png but the actual committed image is cover.avif — extension mismatch
src/routes/blog/post/announcing-appwrite-react-library/+page.markdoc New blog post announcing the React library; code snippets look correct, cover image now committed alongside
src/routes/docs/products/auth/react/+page.markdoc New reference doc for the React library; hook tables and server helper examples are consistent and accurate
src/routes/docs/quick-starts/nextjs/+page.markdoc Rewrote Next.js quickstart to use @appwrite.io/react with SSR handler, server helpers, and AppwriteProvider pattern
src/routes/docs/quick-starts/tanstack-start/+page.markdoc Rewrote TanStack Start quickstart to use @appwrite.io/react; includes multi-route app guidance note
src/routes/docs/quick-starts/react/+page.markdoc Rewrote Vite React quickstart to use @appwrite.io/react hooks; clean and accurate
src/routes/docs/sdks/+page.markdoc Added React library 0.1.0 (beta) entry to the SDKs page pointing to sdk-for-react
src/routes/docs/products/auth/+layout.svelte Added React library sidebar entry marked new until 30 June 2026
src/routes/changelog/(entries)/2026-06-24.markdoc Changelog entry for the React library announcement; correct date and cover reference
static/images/blog/announcing-appwrite-react-library/cover.avif Cover image added as avif; matches frontmatter reference in blog post and changelog

Reviews (7): Last reviewed commit: "Add React library launch cover, changelo..." | Re-trigger Greptile

Comment thread src/routes/docs/quick-starts/tanstack-start/+page.markdoc
Rewrites the AI quickstart prompts under react/, nextjs/, and tanstack-start/ to use @appwrite.io/react instead of the raw Appwrite Web SDK setup, mirroring the rewritten +page.markdoc files.
- Fix admin client example: call admin.account.list() instead of dereferencing the Account service
- Add multi-route guidance to the TanStack Start quickstart so readers know to move AppwriteProvider into __root.tsx in real apps
- Wrap the blog useAuth() snippet in a function component to satisfy the Rules of Hooks
- Format prompt.md files per prettier
Reflects the new framework helper method that returns the full node-appwrite AdminServer (users, databases, storage, teams, and the rest). Hub keeps the standalone createAdminClient as an alternative.
title: "Announcing the Appwrite React library"
description: A small set of React hooks and SSR adapters that take the busywork out of wiring Appwrite Auth into Vite, Next.js, and TanStack Start apps.
date: 2026-05-25
cover: /images/blog/announcing-appwrite-react-library/cover.avif

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Blog post cover image is missing from the repository

The frontmatter references /images/blog/announcing-appwrite-react-library/cover.avif, but the directory static/images/blog/announcing-appwrite-react-library/ does not exist anywhere in the repo. Every other blog post in static/images/blog/ has its cover image committed alongside the post. Publishing this as-is will render a broken image on the blog listing and the post page itself.

Sets the announcement blog cover to the new React SDK artwork (date moved to 2026-06-24), adds the matching 2026-06-24 changelog entry, and tags the React library row in /docs/sdks as beta to align with the React Native SDK row.
Comment thread .optimize-cache.json
"static/images/blog/announcing-appwrite-pro/credits.png": "285905e1fd8b8282cb45a4f2259debd851812c23665145d865e141f5133c0be0",
"static/images/blog/announcing-appwrite-pro/header.png": "ab709ff45870607ec4472bd4dc9e4a028e320bbfb89009ec04c98ec69248a15a",
"static/images/blog/announcing-appwrite-pro/pro.png": "01427f30610de4d6d19cd9160154d8849ffa75da04d063d12bf3e9bba481b4e7",
"static/images/blog/announcing-appwrite-react-library/cover.png": "db2536faba9c82ad441662e10bf69375c8f6d1716e151324e37b0a5bbca9ee48",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 The cache key records the cover image as cover.png, but the file actually committed to the repo is cover.avif. If the image optimization pipeline consults this cache to decide what to skip or where to find the processed artifact, it will look for a .png that doesn't exist and never register the real .avif file as cached. The key should match the actual filename.

Suggested change
"static/images/blog/announcing-appwrite-react-library/cover.png": "db2536faba9c82ad441662e10bf69375c8f6d1716e151324e37b0a5bbca9ee48",
"static/images/blog/announcing-appwrite-react-library/cover.avif": "db2536faba9c82ad441662e10bf69375c8f6d1716e151324e37b0a5bbca9ee48",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant